Summary Service
Dieser Service enthält Methoden um auf die Zeitkonten der TimePunch Profile zugreifen zu können.
GetSummaryLocks
Diese Methode liefert alle Informationen zu den Monatsabschlüssen der Mitarbeiter zurück, die über das Suchobjekt gefunden werden.
List<SummaryLockDto> GetSummaryLocks(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userFilter = null);
| Needed Permission | monthend@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userFilter | Search object containing the user filter. The coverage will be applied to the filter. | |
| Return value | List that contains all summary locks for the found staff members. |
LoadAllYearlySummaries
Diese Methode lädt alle Jahresabschlüsse für den autorisierten Mitarbeiter und gibt diese zurück.
List<YearlySummaryDto> LoadAllYearlySummaries(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| Return value | List containing all yearly sumamries for the given user. |
LoadDailySummaries
Mit dieser Methode kann eine Zusammenfassung der täglichen Arbeitszeit geladen werden.
List<DailySummaryDto> LoadDailySummaries(
out TpFault fault,
TpAuthentication authentication,
DateTime startDate,
DateTime endDate);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| startDate | First date to retrieve the daily summary | |
| endDate | Last date to retrieve the daily summary | |
| Return value | List that contains all daily summaries from start through end date |
LoadAllMonthlySummaries
Diese Methode kann dazu verwendet werden, um alle monatlichen Zusammenfassungen der Arbeitszeit für einen Benutzer zu laden.
List<MonthlySummaryDto> LoadAllMonthlySummaries(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication |
LoadMonthlySummary
Diese Methode lädt die monatliche Zusammenfassung der Arbeitszeit für den Benutzer zu einem bestimmten Referenzdatum.
MonthlySummaryDto LoadMonthlySummary(
out TpFault fault,
TpAuthentication authentication,
DateTime? referenceDate = null);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| referenceDate | Date for that the monthly Summary shall be loaded, or null if the monthly summary for the current date shall be returned. | |
| Return value | The monthly summary for the given reference date. |
LoadMonthlySummaries
Diese Methode lädt alle monatlichen Zusammenfassungen mit den übergebenen Ids.
List<MonthlySummaryDto> LoadMonthlySummaries(
out TpFault fault,
TpAuthentication authentication,
List<Guid> summaryIds);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| summaryIds | Ids of the monthly summaries to load. | |
| Return value | The monthly summary for the given reference date. |
LoadTimeAccounts
Diese Methode lädt die aktuellen Zeitkonten der Mitarbeiter. Je nachdem, ob nur auf das Zeitkonto des autorisierten Mitarbeiters oder auf alle Mitarbeiterkonten zugegriffen werden soll, werden unterschiedliche Rechte benötigt.
List<TimeAccountDto> LoadTimeAccounts(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userSearch,
DateTime? referenceDate = null);
| Needed Permission | timeAccounts@access / timeAccounts@report | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userSearch | Information that are used to search the TimePunch profiles | |
| referenceDate | The date of which the time accounts shall be loaded. By default this is always the day before today | |
| Return value | List of Time account information entities |
LoadYearlySummary
Diese Methode lädt die jährlichen Urlaubsdaten für den autorisierten Mitarbeiter anhand des Referenzdatums.
YearlySummaryDto LoadYearlySummary(
out TpFault fault,
TpAuthentication authentication,
DateTime? referenceDate = null);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| referenceDate | The date of which the yearly summary shall be loaded, or null if the current date is used. | |
| Return value | The yearly summary for the given user and reference date. |
LoadYearlySummaryByYear
Diese Methode lädt die jährlichen Urlaubsdaten für den autorisierten Mitarbeiter für ein definiertes Jahr.
YearlySummaryDto LoadYearlySummaryByYear(
out TpFault fault,
TpAuthentication authentication,
int year);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| year | The year of the yearly summary to load. | |
| Return value | The yearly summary for the given user and reference date. |
ReCalculateAllSummaries
Diese Methode erzwingt das Neuberechnen aller Monatsdaten der im User Filter angegebenen Mitarbeiter ab dem Referenzdatum.
void ReCalculateAllSummaries(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userFilter,
DateTime? referenceDate = null)
| Needed Permission | summary@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userFilter | Filter that is used to search the TimePunch profiles. | |
| referenceDate | Defines the date since when the monthly summaries shall be re-calculated. If NULL, all monthly summaries of a user will be re-calculated. | |
| Return value | The calculated monthly summary, after the calculation date has been applied. |
SaveMonthlySummary
Diese Methode speichert die Basisdaten zur Berechnung der monatlichen Arbeitsdaten.
MonthlySummaryDto SaveMonthlySummary(
out TpFault fault,
TpAuthentication authentication,
MonthlySummarySaveDto summary);
| Needed Permission | summary@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| summary | Contains the data that can be used to calculate the monthly working time data. | |
| Return value | The calculated monthly summary, after the calculation date has been applied. |
SaveYearlySummary
Diese Methode speichert die Basisdaten zur Berechnung des jährlichen Urlaubskontos.
YearlySummaryDto SaveYearlySummary(
out TpFault fault,
TpAuthentication authentication,
YearlySummarySaveDto summary);
| Needed Permission | summary@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| summary | Contains the data that can be used to calculate the annual leave. | |
| Return value | The calculated annual leave, after the calculation date has been applied. |
SearchMonthlySummaries
Diese Methode liefert anhand der übergebenen Suchparameter alle monatlichen Zusammenfassungen zurück.
List<MonthlySummaryDto> SearchMonthlySummaries(
out TpFault fault,
TpAuthentication authentication,
MonthlySummarySearchDto searchDto);
| Needed Permission | summary@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| searchDto | Search object to specify the summaries that will be returned. | |
| Return value | The found monthly summaries |
SetSummaryLocks
Mit Hilfe dieser Methode kann der Monatsabschluss durchgeführt werden. Der Abschluss wird entweder für den gerade angemeldeten Mitarbeiter durchgeführt (falls die UserIDs NULL sind) oder für alle übergebenen IDs der Mitarbeiter.
void SetSummaryLocks(
out TpFault fault,
TpAuthentication authentication,
DateTime? lockedUpTo,
List<Guid> userIds = null);
| Needed Permission | CAN_MANAGE_MONTHEND, if lockedUpTo is filled CAN_RESET_MONTHEND, if lockedUpTo is NULL | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| lockedUpTo | Date up to that the month ends gets locked. If the lockedUpTo is NULL all months will be unlocked. | |
| userIds | A list that contains the user ids for that the month end closing will be executed. If the list is NULL or empty, the current identity user will be used. |